<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
	<title>YUI Library Examples: ProfilerViewer Control: Using Profiler and ProfilerViewer to Profile non-YUI Code</title>
    

    <meta http-equiv="content-type" content="text/html; charset=utf-8">
    	<link rel="stylesheet" type="text/css" href="../../assets/yui.css" >

<style>
/*Supplemental CSS for the YUI distribution*/
#custom-doc { width: 95%; min-width: 950px; }
#pagetitle {background-image: url(../../assets/bg_hd.gif);}
#pagetitle h1 {background-image: url(../../assets/title_h_bg.gif);}

</style>

<link rel="stylesheet" type="text/css" href="../../assets/dpSyntaxHighlighter.css">
<!--Script and CSS includes for YUI dependencies on this page-->
<link rel="stylesheet" type="text/css" href="../../build/button/assets/skins/sam/button.css" />
<script type="text/javascript" src="../../build/yuiloader/yuiloader-min.js"></script>
<script type="text/javascript" src="../../build/profiler/profiler-min.js"></script>
<script type="text/javascript" src="../../build/event/event-min.js"></script>
<script type="text/javascript" src="../../build/dom/dom-min.js"></script>
<script type="text/javascript" src="../../build/element/element-min.js"></script>
<script type="text/javascript" src="../../build/button/button-min.js"></script>


<!--begin custom header content for this example-->

<!--end custom header content for this example-->


<script type="text/javascript">
//enable passthrough of errors from YUI Event:
if ((typeof YAHOO !== "undefined") && (YAHOO.util) && (YAHOO.util.Event)) {
	YAHOO.util.Event.throwErrors = true;
}
</script>
</head>
<body id="yahoo-com" class=" yui-skin-sam">
<div id="custom-doc" class="yui-t2">
<div id="hd">
	<div id="ygunav">
		<p><em><a href="http://developer.yahoo.com/yui/">YUI Library Home</a></em></p>
		<form action="http://search.yahoo.com/search" id="sitesearchform">
		<input name="vs" type="hidden" value="developer.yahoo.com">
		<input name="vs" type="hidden" value="yuiblog.com">
		<div id="sitesearch">
			<label for="searchinput">Site Search (YDN &amp; YUIBlog): </label>
			<input type="text" id="searchinput" name="p">
			<input type="submit" value="Search" id="searchsubmit" class="ygbt">
		</div>
		</form>	</div>
	<div id="ygma"><a href="../../"><img src="../../assets/yui.gif"  border="0" height="38"></a></div>
	<div id="pagetitle"><h1>YUI Library Examples: ProfilerViewer Control: Using Profiler and ProfilerViewer to Profile non-YUI Code</h1></div>
</div>
<div id="bd">
	
	<div id="yui-main">
		<div class="yui-b">
		  <div class="yui-ge">
			  <div class="yui-u first example">

    
	<div class="promo">
	<h1>ProfilerViewer Control: Using Profiler and ProfilerViewer to Profile non-YUI Code</h1>
	
	<div class="exampleIntro">
	<p>The <a href="http://developer.yahoo.com/yui/profilerviewer/">ProfilerViewer Control</a> (and the <a href="http://developer.yahoo.com/yui/profiler/">Profiler</a> that drives it) is code-agnostic: It can be used as easily to profile your own code or third-party code as it can to profile YUI modules.  In this example, we use Profiler and ProfilerViewer to profile the <a href="http://code.google.com/p/syntaxhighlighter/">DP Syntax Highlighter</a> script that the YUI Project uses for code highlighting on our website.</p>
<p>To lighten the initial YUI footprint on the page (and minimize the impact of YUI on the script being profiled), this example takes the following steps:</p>
<ol><li><a href="http://developer.yahoo.com/yui/yuiloader/">YUI Loader</a> and Profiler are loaded first, along with the script being profiled. By putting only a tiny amount of YUI code on the page, we should be able to run DP Syntax Highlighter without its performance being impacted much by YUI.</li>
  <li>Once DP Syntax Highlighter has run, a button allows you to actuate ProfilerViewer, loading its dependencies on-demand in the process.</li>
</ol>			
	</div>	
					
	<div class="example-container module  newWindow">
			<div id="example-canvas" class="bd">
	
		<p class="newWindowButton yui-skin-sam"><span id="newWindowLink"><span class="first-child"><a href="pv-bootstrap_source.html" target="_blank">View example in new window.</a></span></span>		
	
		
		</div>
		
	
	</div>			
	</div>
		
	<h2 class="first">Profiling non-YUI Code with Minimal YUI Dependencies</h2>

<p>In the introduction to this example, we note that the goal here is to profile non-YUI code while loading (at the outset) only the bare minimum of YUI components (YUI Loader and Profiler, in this case).  By keeping the initial YUI footprint small, we can be sure that YUI iteslf is having the smallest possible impact on the code were looking at.  So, in this example we load that minimal footprint, profile the code we want to test, and only then bring in YUI ProfilerViewer and its other YUI dependencies.  This approach is a good one to take when you're profiling projects that are not based on YUI or where you want to minimize the impact ProfilerViewer could have on your profiling data.</p>

<p>Here's how we accomplish the steps outlined above.  (Note: It's the script-based code-highlighting used below that's being profiled in this example.)</p>

<p>First, we load the minimal dependencies for profiling code with YUI Profiler.  To that, we add the DP Syntax Highlighter code (ie, the code that we'll be profiling).</p>

<textarea name="code" class="HTML" cols="60" rows="1"><link rel="stylesheet" type="text/css" href="http://developer.yahoo.com/yui/examples/profilerviewer/assets/dpSyntaxHighlighter.css"> 

<script type="text/javascript" src="http://yui.yahooapis.com/2.7.0/build/yuiloader/yuiloader-min.js"></script>
<script type="text/javascript" src="http://yui.yahooapis.com/2.7.0/build/profiler/profiler-min.js"></script>
<script type="text/javascript" src="http://developer.yahoo.com/yui/examples/profilerviewer/assets/dpSyntaxHighlighter.js"></script></textarea>


<p>Next, we set up a simple initialization function that (a) sets up the code we want to profile then (b) executes the code:</p>


<textarea name="code" class="CSS" cols="60" rows="1">YAHOO.example.pv.init = function() {

	//profile the Syntax Highlighter; note: we want to register the
	//object for profiling before we execute the highlighting code:
	YAHOO.tool.Profiler.registerConstructor("dp.sh.Highlighter");
	YAHOO.tool.Profiler.registerObject("dpSyntaxHighlighter", dp, true);

	//Highlight code:
	dp.SyntaxHighlighter.HighlightAll('code');

};

YAHOO.example.pv.init();</textarea>

<p>At this point, we've told Profiler what parts of Syntax Highlighter we want profiled and we've then run Syntax Highlighter, capturing data about its performance.  And we've done all this with the smallest possible amount of YUI code on the page.  <em>Note that Profiler is loaded now, but ProfilerViewer and all of the YUI infrastructure it leverages &mdash; like Element, DataTable and Charts &mdash; is still absent.</em></p>

<p>Now it's time to set up a button that brings in the YUI ProfilerViewer and all of its dependencies.  That button executes the following code:</p>

<textarea name="code" class="JScript" cols="60" rows="1">//When the showProfile button is clicked, use YUI Loader to get all required
//dependencies and then show the profile:
YAHOO.example.pv.showProfilerViewer = function() {

	//disable the button once it's clicked:
	document.getElementById("showProfile").onclick = "";
	document.getElementById("showProfile").className += " disabled";
	
	//private function renders the viewer once dependencies are loaded:
	var showViewer = function() {

		//instantiate ProfilerViewer with desired options:
		var pv = new YAHOO.widget.ProfilerViewer("", {
			visible: true, //expand the viewer mmediately after instantiation
			showChart: true,
			base:"../../build/",
			swfUrl: "../../build/charts/assets/charts.swf"
		});
	};

	//private function gets dependencies for ProfilerViewer:
	var getProfilerViewer = function() {
		var loader = new YAHOO.util.YUILoader({
			base: "../../build/",
			require: ["profilerviewer"], //YUI Loader will handle all dependencies
									  //for us. Nice!
			onSuccess: showViewer
		});
		loader.insert();
	};
	
	//fire getProfilerViewer to trigger the loading and display of the viewer
	//console:
	getProfilerViewer();

};</textarea>

<p>You can use similar strategies to leverage YUI's Profiler and ProfilerViewer on your projects &mdash; even those that aren't based on YUI.</p>

<p>The full script souce for this example follows:</p>
	
<textarea name="code" class="JScript" cols="60" rows="1">YAHOO.namespace("example.pv");

YAHOO.example.pv.init = function() {

	//profile the Syntax Highlighter; note: we want to register the
	//object for profiling before we execute the highlighting code:
	YAHOO.tool.Profiler.registerConstructor("dp.sh.Highlighter");
	YAHOO.tool.Profiler.registerObject("dpSyntaxHighlighter", dp, true);

	//Highlight code:
	dp.SyntaxHighlighter.HighlightAll('code');

};

//When the showProfile button is clicked, use YUI Loader to get all required
//dependencies and then show the profile:
YAHOO.example.pv.showProfilerViewer = function() {

	//disable button:
	document.getElementById("showProfile").onclick = "";
	document.getElementById("showProfile").className += " disabled";
	
	//private function renders the viewer once dependencies are loaded:
	var showViewer = function() {

		//instantiate ProfilerViewer with desired options:
		var pv = new YAHOO.widget.ProfilerViewer("", {
			visible: true, //expand the viewer mmediately after instantiation
			showChart: true,
			base:"../../build/",
			swfUrl: "../../build/charts/assets/charts.swf"
		});
	};

	//private function gets dependencies for ProfilerViewer:
	var getProfilerViewer = function() {
		var loader = new YAHOO.util.YUILoader({
			base: "../../build/",
			require: ["profilerviewer"], //YUI Loader will handle all dependencies
									  //for us. Nice!
			onSuccess: showViewer
		});
		loader.insert();
	};
	
	//fire getProfilerViewer to trigger the loading and display of the viewer
	//console:
	getProfilerViewer();

};

YAHOO.example.pv.init();</textarea>

</script>

<h2>Configuration for This Example</h2>

<p>You can load the necessary JavaScript and CSS for this example from Yahoo's servers.  <a href="http://developer.yahoo.com/yui/articles/hosting/?yuiloader&profiler&MIN#configure">Click here to load the YUI Dependency Configurator with all of this example's dependencies preconfigured</a>.</p>

				</div>
				<div class="yui-u">
					
				
					<div id="examples">
						<h3 class='firstContent'>ProfilerViewer Control Examples:</h3>
	
						<div id="exampleToc">
							<ul>
								<li><a href='../profilerviewer/pv-basic.html'>Simple Profiling</a></li><li><a href='../profilerviewer/pv-api.html'>Using the ProfilerViewer API while Profiling the YUI Menu Control</a></li><li class='selected'><a href='../profilerviewer/pv-bootstrap.html'>Using Profiler and ProfilerViewer to Profile non-YUI Code</a></li><li><a href='../profilerviewer/pv-skin.html'>Skinning the ProfilerViewer Control</a></li><li><a href='../profilerviewer/pv-spanish.html'>ProfilerViewer Internationalization: Spanish</a></li><li><a href='../profilerviewer/pv-german.html'>ProfilerViewer Internationalization: German</a></li>							</ul>
						</div>
					</div>
					
					<div id="module">
						<h3>More ProfilerViewer Control Resources:</h3>
						<ul>
							<li><a href="http://developer.yahoo.com/yui/profilerviewer/">User's Guide</a> (external)</li>
						<li><a href="../../docs/module_profilerviewer.html">API Documentation</a></li>
                            
                            
							<li><a href="http://yuiblog.com/assets/pdf/cheatsheets/profilerviewer.pdf">Cheat Sheet PDF</a> (external)</li></ul>
					</div>
			  </div>
		</div>
		
		</div>
	</div>


<div class="yui-b" id="tocWrapper">
<!-- TABLE OF CONTENTS -->
<div id="toc">
	
<ul>
<li class="sect first">Yahoo! UI Library</li><li class="item"><a title="The Yahoo! User Interface Library (YUI)" href="http://developer.yahoo.com/yui/">Home (external)</a></li><li class="item"><a title="The Yahoo! User Interface Blog" href="http://yuiblog.com">YUIBlog (external)</a></li><li class="item"><a title="The Yahoo! Group YDN-JavaScript hosts the YUI community forum" href="http://tech.groups.yahoo.com/group/ydn-javascript/">YUI Discussion Forum (external)</a></li><li class="item"><a title="The YUI Library source can be checked out from GitHub" href="http://github.com/yui/">YUI on GitHub</a></li><li class="item"><a title="Instantly searchable API documentation for the entire YUI library." href="../../docs/index.html">API Documentation</a></li><li class="item"><a title="Examples of every YUI utility and control in action" href="../../examples/">Functional Examples</a></li><li class="item"><a title="Videos and podcasts from the YUI Team and from the Yahoo! frontend engineering community." href="http://developer.yahoo.com/yui/theater/">YUI Theater (external)</a></li><li class="item"><a title="YUI is free and open, offered under a BSD license." href="http://developer.yahoo.com/yui/license.html">YUI License (external)</a></li><li class="sect">YUI Functional Examples</li><li class="item"><a title="The YUI Animation Utility - Functional Examples" href="../../examples/animation/index.html">Animation</a></li><li class="item"><a title="The YUI AutoComplete Control - Functional Examples" href="../../examples/autocomplete/index.html">AutoComplete</a></li><li class="item"><a title="The YUI Browser History Manager - Functional Examples" href="../../examples/history/index.html">Browser History Manager</a></li><li class="item"><a title="The YUI Button Control - Functional Examples" href="../../examples/button/index.html">Button</a></li><li class="item"><a title="The YUI Calendar Control - Functional Examples" href="../../examples/calendar/index.html">Calendar</a></li><li class="item"><a title="The YUI Carousel Control - Functional Examples" href="../../examples/carousel/index.html">Carousel</a></li><li class="item"><a title="The YUI Charts Control - Functional Examples" href="../../examples/charts/index.html">Charts (experimental)</a></li><li class="item"><a title="The YUI Color Picker Control - Functional Examples" href="../../examples/colorpicker/index.html">Color Picker</a></li><li class="item"><a title="The YUI Cookie Utility - Functional Examples" href="../../examples/cookie/index.html">Cookie</a></li><li class="item"><a title="The YUI Connection Manager (AJAX) - Functional Examples" href="../../examples/connection/index.html">Connection Manager</a></li><li class="item"><a title="The YUI Container Family (Module, Overlay, Tooltip, Panel, Dialog, SimpleDialog) - Functional Examples" href="../../examples/container/index.html">Container</a></li><li class="item"><a title="The YUI DataTable Control - Functional Examples" href="../../examples/datatable/index.html">DataTable</a></li><li class="item"><a title="The YUI Dom Collection - Functional Examples" href="../../examples/dom/index.html">Dom</a></li><li class="item"><a title="The YUI Drag &amp; Drop Utility - Functional Examples" href="../../examples/dragdrop/index.html">Drag &amp; Drop</a></li><li class="item"><a title="The YUI Event Utility - Functional Examples" href="../../examples/event/index.html">Event</a></li><li class="item"><a title="The YUI Get Utility - Functional Examples" href="../../examples/get/index.html">Get</a></li><li class="item"><a title="The YUI ImageCropper Control - Functional Examples" href="../../examples/imagecropper/index.html">ImageCropper</a></li><li class="item"><a title="The YUI ImageLoader Utility - Functional Examples" href="../../examples/imageloader/index.html">ImageLoader</a></li><li class="item"><a title="The YUI JSON Utility - Functional Examples" href="../../examples/json/index.html">JSON</a></li><li class="item"><a title="The YUI Layout Manager - Functional Examples" href="../../examples/layout/index.html">Layout Manager</a></li><li class="item"><a title="The YUI Logger Control - Functional Examples" href="../../examples/logger/index.html">Logger</a></li><li class="item"><a title="The YUI Menu Control - Functional Examples" href="../../examples/menu/index.html">Menu</a></li><li class="item"><a title="The YUI Paginator - Functional Examples" href="../../examples/paginator/index.html">Paginator</a></li><li class="item"><a title="The YUI Profiler Utility - Functional Examples" href="../../examples/profiler/index.html">Profiler</a></li><li class="selected "><a title="The YUI ProfileViewer Control - Functional Examples" href="../../examples/profilerviewer/index.html">ProfilerViewer</a></li><li class="item"><a title="The YUI Resize Utility - Functional Examples" href="../../examples/resize/index.html">Resize</a></li><li class="item"><a title="The YUI Rich Text Editor - Functional Examples" href="../../examples/editor/index.html">Rich Text Editor</a></li><li class="item"><a title="The YUI Selector Utility - Functional Examples" href="../../examples/selector/index.html">Selector</a></li><li class="item"><a title="The YUI Slider Control - Functional Examples" href="../../examples/slider/index.html">Slider</a></li><li class="item"><a title="The YUI Stylesheet Utility - Functional Examples" href="../../examples/stylesheet/index.html">Stylesheet</a></li><li class="item"><a title="The YUI TabView Control - Functional Examples" href="../../examples/tabview/index.html">TabView</a></li><li class="item"><a title="The YUI TreeView Control - Functional Examples" href="../../examples/treeview/index.html">TreeView</a></li><li class="item"><a title="The YUI Uploader Utility - Functional Examples" href="../../examples/uploader/index.html">Uploader (experimental)</a></li><li class="item"><a title="The YUI YAHOO Global Object - Functional Examples" href="../../examples/yahoo/index.html">YAHOO Global Object</a></li><li class="item"><a title="The YUI Loader Utility - Functional Examples" href="../../examples/yuiloader/index.html">YUI Loader</a></li><li class="item"><a title="The YUI Test Utility - Functional Examples" href="../../examples/yuitest/index.html">YUI Test</a></li><li class="item"><a title="YUI Reset CSS - Functional Examples" href="../../examples/reset/index.html">Reset CSS</a></li><li class="item"><a title="YUI Base CSS - Functional Examples" href="../../examples/base/index.html">Base CSS</a></li><li class="item"><a title="YUI Fonts CSS - Functional Examples" href="../../examples/fonts/index.html">Fonts CSS</a></li><li class="item"><a title="YUI Grids CSS - Functional Examples" href="../../examples/grids/index.html">Grids CSS</a></li><li class="sect">YUI Articles on the YUI Website</li><li class="item"><a title="Answers to Frequently Asked Questions about the YUI Library" href="http://developer.yahoo.com/yui/articles/faq/">YUI FAQ (external)</a></li><li class="item"><a title="Yahoo!'s philosophy of Graded Browser Support" href="http://developer.yahoo.com/yui/articles/gbs/">Graded Browser Support (external)</a></li><li class="item"><a title="Reporting Bugs and Making Feature Requests for YUI Components" href="http://developer.yahoo.com/yui/articles/reportingbugs/">Bug Reports/Feature Requests (external)</a></li><li class="item"><a title="Serve YUI source files from Yahoo! -- free, fast, and simple" href="http://developer.yahoo.com/yui/articles/hosting/">Serving YUI Files from Yahoo! (external)</a></li><li class="item"><a title="Best practices for working with web services while protecting user privacy" href="http://developer.yahoo.com/security/">Security Best Practices (external)</a></li></ul>
</div>
</div>
	</div><!--closes bd-->

	<div id="ft">
        <p class="first">Copyright &copy; 2009 Yahoo! Inc. All rights reserved.</p>
        <p><a href="http://privacy.yahoo.com/privacy/us/devel/index.html">Privacy Policy</a> - 
            <a href="http://docs.yahoo.com/info/terms/">Terms of Service</a> - 
            <a href="http://docs.yahoo.com/info/copyright/copyright.html">Copyright Policy</a> - 
            <a href="http://careers.yahoo.com/">Job Openings</a></p>
	</div>
</div>
<script src="../../assets/dpSyntaxHighlighter.js"></script>
<script language="javascript"> 
dp.SyntaxHighlighter.HighlightAll('code'); 
</script>

<script src='../../assets/YUIexamples.js'></script>


</body>
</html>
<!-- presentbright.corp.yahoo.com uncompressed/chunked Thu Feb 19 10:53:18 PST 2009 -->
